Wolters Kluwer CCH® SureTax®

    Show / Hide Table of Contents

    Investigator API

    POST Saved Search

    POST Saved Search

    Overview

    Creates a new saved search.

    OperationId: POST Saved Search

    Authorization Method(s): OAuth

    Verb: POST

    End Point: /api/configuration/user/savedsearch


    Request Body
    Request Model
    Display NameField NameField Type
    Name namestring
    Notes notesstring
    Search searchSearchDto
    Folder Id folderIdinteger
    SearchDto
    Display NameField NameField Type
    Search By searchBySearchBy
    Rate Changes Search By rateChangesSearchByRateChangesSearchBy
    Taxability Changes Search By taxabilityChangesSearchByCommonSearchBy
    Taxability Matrix Search By taxabilityMatrixSearchByTaxMatrixSearchBy
    Rate Directory Search By rateDirectorySearchByRateDirectorySearchBy
    Search Type searchTypeSearchType
    SearchBy
    Display NameField NameField Type
    Client Number *clientNumberstring
    Search Country searchCountrySearchCountry
    Search Option searchOptionSearchOption
    Search Type searchTypestring
    Parameters parametersSearchParameters
    Filters filtersSearchFilters
    SearchCountry
    Display NameField NameField Type
    SearchOption
    Display NameField NameField Type
    SearchParameters
    Display NameField NameField Type
    Postal Code postalCodestring
    Npanxx npanxxstring
    Location Id locationIdstring
    Address addressAddress
    State County City stateCountyCityStateCountyCity
    As Of Date asOfDatestring
    Geocode geocodestring
    Address
    Display NameField NameField Type
    Address1 address1string
    Address2 address2string
    City citystring
    County countystring
    Postal Code postalCodestring
    Plus4 plus4string
    State statestring
    StateCountyCity
    Display NameField NameField Type
    State *statestring
    County countystring
    City citystring
    SearchFilters
    Display NameField NameField Type
    Customer Usage Type customerUsageTypestring
    Provider Type providerTypeproviderTypes
    List Items By listItemsBySearchListItemsBy
    Product Group productGroupstring
    Product Item productItemstring
    Sku skustring
    SearchListItemsBy
    Display NameField NameField Type
    RateChangesSearchBy
    Display NameField NameField Type
    Client Number *clientNumberstring
    Search Country searchCountrySearchCountry
    Search Option searchOptionSearchOption
    Search Type searchTypestring
    Filters filtersRateChangesFilters
    Parameters parametersRateChangesSearchParameters
    SearchCountry
    Display NameField NameField Type
    SearchOption
    Display NameField NameField Type
    RateChangesFilters
    Display NameField NameField Type
    Customer Usage Type customerUsageTypestring
    Provider Type providerTypeproviderTypes
    Start Date startDateDataYearMonth
    End Date endDateDataYearMonth
    Release Number releaseNumberinteger
    Date Type dateTypeRateChangesDateType
    DataYearMonth
    Display NameField NameField Type
    Year *yearstring
    Month *monthstring
    Day dayinteger
    DataYearMonth
    Display NameField NameField Type
    Year *yearstring
    Month *monthstring
    Day dayinteger
    RateChangesDateType
    Display NameField NameField Type
    RateChangesSearchParameters
    Display NameField NameField Type
    Pgpis pgpisarray[Pgpi]
    Postal Code postalCodestring
    Npanxx npanxxstring
    Locations locationsarray[]
    Address addressAddress
    State County City stateCountyCityStateCountyCity
    Geocode geocodestring
    By bySearchListItemsBy
    Skus skusarray[]
    Pgpi
    Display NameField NameField Type
    Product Group productGroupstring
    Product Item productItemstring
    Address
    Display NameField NameField Type
    Address1 address1string
    Address2 address2string
    City citystring
    County countystring
    Postal Code postalCodestring
    Plus4 plus4string
    State statestring
    StateCountyCity
    Display NameField NameField Type
    State *statestring
    County countystring
    City citystring
    SearchListItemsBy
    Display NameField NameField Type
    CommonSearchBy
    Display NameField NameField Type
    Client Number *clientNumberstring
    Search Country searchCountrySearchCountry
    Search Option searchOptionSearchOption
    Search Type searchTypestring
    Filters filtersCommonSearchFilters
    Parameters parametersCommonSearchParameters
    SearchCountry
    Display NameField NameField Type
    SearchOption
    Display NameField NameField Type
    CommonSearchFilters
    Display NameField NameField Type
    Customer Usage Type customerUsageTypestring
    Provider Type providerTypeproviderTypes
    Start Date startDateDataYearMonth
    End Date endDateDataYearMonth
    Release Number releaseNumberinteger
    Date Type dateTypeSearchDateType
    DataYearMonth
    Display NameField NameField Type
    Year *yearstring
    Month *monthstring
    Day dayinteger
    DataYearMonth
    Display NameField NameField Type
    Year *yearstring
    Month *monthstring
    Day dayinteger
    SearchDateType
    Display NameField NameField Type
    CommonSearchParameters
    Display NameField NameField Type
    Pgpis pgpisarray[Pgpi]
    Postal Code postalCodestring
    Npanxx npanxxstring
    Locations locationsarray[]
    Address addressAddress
    State County City stateCountyCityStateCountyCity
    Geocode geocodestring
    By bySearchListItemsBy
    Skus skusarray[]
    Pgpi
    Display NameField NameField Type
    Product Group productGroupstring
    Product Item productItemstring
    Address
    Display NameField NameField Type
    Address1 address1string
    Address2 address2string
    City citystring
    County countystring
    Postal Code postalCodestring
    Plus4 plus4string
    State statestring
    StateCountyCity
    Display NameField NameField Type
    State *statestring
    County countystring
    City citystring
    SearchListItemsBy
    Display NameField NameField Type
    TaxMatrixSearchBy
    Display NameField NameField Type
    Client Number *clientNumberstring
    Search Country searchCountrySearchCountry
    Search Option searchOptionSearchOption
    Search Type searchTypestring
    Filters filtersTaxMatrixSearchFilters
    Parameters parametersCommonSearchParameters
    SearchCountry
    Display NameField NameField Type
    SearchOption
    Display NameField NameField Type
    TaxMatrixSearchFilters
    Display NameField NameField Type
    Customer Usage Type *customerUsageTypestring
    Provider Type *providerTypeproviderTypes
    As Of Date asOfDateDataYearMonth
    Release Number releaseNumberinteger
    Date Type dateTypeSearchDateType
    DataYearMonth
    Display NameField NameField Type
    Year *yearstring
    Month *monthstring
    Day dayinteger
    SearchDateType
    Display NameField NameField Type
    CommonSearchParameters
    Display NameField NameField Type
    Pgpis pgpisarray[Pgpi]
    Postal Code postalCodestring
    Npanxx npanxxstring
    Locations locationsarray[]
    Address addressAddress
    State County City stateCountyCityStateCountyCity
    Geocode geocodestring
    By bySearchListItemsBy
    Skus skusarray[]
    Pgpi
    Display NameField NameField Type
    Product Group productGroupstring
    Product Item productItemstring
    Address
    Display NameField NameField Type
    Address1 address1string
    Address2 address2string
    City citystring
    County countystring
    Postal Code postalCodestring
    Plus4 plus4string
    State statestring
    StateCountyCity
    Display NameField NameField Type
    State *statestring
    County countystring
    City citystring
    SearchListItemsBy
    Display NameField NameField Type
    RateDirectorySearchBy
    Display NameField NameField Type
    Client Number *clientNumberstring
    Search Country searchCountrySearchCountry
    Search Option searchOptionSearchOption
    Search Type searchTypestring
    Filters filtersRateDirectorySearchFilters
    Parameters parametersRateDirectorySearchParameters
    SearchCountry
    Display NameField NameField Type
    SearchOption
    Display NameField NameField Type
    RateDirectorySearchFilters
    Display NameField NameField Type
    Release Number releaseNumberinteger
    Date Type dateTypeSearchDateType
    SearchDateType
    Display NameField NameField Type
    RateDirectorySearchParameters
    Display NameField NameField Type
    Geocode geocodestring
    Locations locationsarray[]
    Postal Code postalCodestring
    Npanxx npanxxstring
    State County City stateCountyCityStateCountyCity
    State stateStates
    As Of Date asOfDateDataYearMonth
    Address addressAddress
    Current Page currentPageinteger
    Page Size pageSizeinteger
    StateCountyCity
    Display NameField NameField Type
    State *statestring
    County countystring
    City citystring
    States
    Display NameField NameField Type
    State statestring
    DataYearMonth
    Display NameField NameField Type
    Year *yearstring
    Month *monthstring
    Day dayinteger
    Address
    Display NameField NameField Type
    Address1 address1string
    Address2 address2string
    City citystring
    County countystring
    Postal Code postalCodestring
    Plus4 plus4string
    State statestring
    SearchType
    Display NameField NameField Type

    Request Headers
    Many of the request headers listed below are designed to enhance traceability and provide supplementary information, allowing our team to efficiently identify and assess your API requests. Including these headers offers numerous benefits: they improve debugging and support by facilitating quick issue identification, enhance security through secure access and traceable actions, ensure accurate request tracking for thorough auditing, support better client management for compatibility, enable localization and personalization for tailored responses, and optimize business processes with clearer operation definitions. For implementation examples, please refer to our SDKs, which provide comprehensive guidance and practical integrations.

    Display String Field Name Field Type
    User Name userName string
    Query Parameters
    Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

    Display String Field Name Field Type
    Api-version* api-version undefined

    *Mandatory parameter

    ProblemDetails

    Overview

    ProblemDetails
    Display NameField NameField Type
    Type typestring
    Title titlestring
    Status statusinteger
    Detail detailstring
    Instance instancestring
    Response Codes
    Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

    code description
    201 Returns the created saved search.
    401 If the user is unauthorized.
    400 If the input is invalid.




    Enter Environment Credentials








    Wolters Kluwer Product Name - Page anchor links toWolters Kluwer Product Name - Page anchor links to
    © Wolters Kluwer and/or its affiliates. All rights reserved.